ManifestReader Class

This is a reader of information contained in the manifest in a SCORM package. The package may be 1.2 or 2004 (1.3) version. The package may not be an LRM.

Namespace: Microsoft.LearningComponents.Manifest

Assembly: Microsoft.LearningComponents.dll

Syntax
C#

public class ManifestReader : IXPathNavigable

Constructors
Name Description
Ð ManifestReader (PackageReader, ManifestReaderSettings)

Create a ManifestReader object that provides access to information within the manifest.

Properties
Name Description
Ð DefaultOrganization

The default organization that will be used, unless another is specified when attempting the package. This will return null content that does not include any organizations.

If there is an error in the default organization identifier, the first organization will be returned when ManifestReaderSettings.FixScormRequirementViolations=true is set.

Ð Id

Returns the id in the manifest that uniquely identifies the package.

Ð Metadata

Return a reader of the package level metadata.

Ð Organizations

Return a read-only list of organizations (OrganizationNodeReader) in the package.

Ð PackageFormat

The PackageFormat of the package, which identifies whether this is a SCORM 2004, SCORM 1.2, or LRM package.

Ð PackageType

Returns the type of SCORM package. Currently, it is either a resource package or a content organization package.

Ð Resources

Return a list of resources contained in the package. The dictionary has the resource id as the key, the ResourceNodeReader as the value.

Ð ResourcesXmlBase

The xml:base attribute, resolved with the manifest's xml:base attribute, of the resources node, if it exists. Otherwise returns null.

Ð SequencingCollection

Return the sequencing collection information in the manifest. This is only valid in SCORM 2004 content, so in SCORM 1.2 content, this collection will always be empty. The key is the <sequencing>/ID and the value is a SequencingNodeReader.

Ð Version

Corresponds to the version attribute of the <manifest> node, which is an optional attribute used to distinguish between manifests with the same identifier.

Ð XmlBase

Return the xml:base attribute of the manifest, if it exists.

Methods
Name Description
Ð CreateNavigator

Return an XPathNavigator to provide XPath query access to the navigator. This allows access to non-Scorm compliant elements and attributes in a manifest.

Remarks

Most of the methods on this class follow the terminology of SCORM 2004. Unless otherwise noted, they are valid for both 1.2 and 2004 content. The reading of information in the manifest is lazy. When an object is created, the data for the object to be read is not parsed. When a property value is requested, that property is read from the XPathNavigator. Exceptions are only thrown if there's no log and reasonable behavior is not possible. There is an option to add errors and warnings to a log provided by the application. If there is a serious error (and exceptions should be thrown), then the exception is thrown. When a list is accessed, the list is created but the elements in the list are only created when they are needed. If PackageValidatorSettings.ScormRequirementValidation=ValidationBehavior.LogWarning or PackageValidatorSettings.ScormRequirementValidation=ValidationBehavior.LogError is set, then exceptions are avoided whenever a reasonable default is possible. For instance, if an element required by the SCORM spec does not exist in the manifest, String.Empty or some other possible valid value is returned.